/* Licensed under the Apache License, Version 2.0 (the "License");
 * you may not use this file except in compliance with the License.
 * You may obtain a copy of the License at
 *
 *      http://www.apache.org/licenses/LICENSE-2.0
 *
 * Unless required by applicable law or agreed to in writing, software
 * distributed under the License is distributed on an "AS IS" BASIS,
 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 * See the License for the specific language governing permissions and
 * limitations under the License.
 */
package org.activiti.cdi.impl.context;

import org.activiti.engine.ActivitiException;
import org.activiti.engine.runtime.Execution;
import org.activiti.engine.task.Task;

import java.util.Map;

/**
 * Represents a means for associating an execution with a context.
 * <p/>
 * This enables activiti-cdi to provide contextual business process management
 * services, without relying on a specific context like i.e. the conversation
 * context.
 *
 * @author Daniel Meyer
 */
public interface ContextAssociationManager {

    /**
     * Disassociates the current process instance with a context / scope
     *
     * @throws ActivitiException if no process instance is currently associated
     */
    public void disAssociate();

    /**
     * @return the id of the execution currently associated or null
     */
    public String getExecutionId();

    /**
     * get the current execution
     */
    public Execution getExecution();

    /**
     * associate with the provided execution
     */
    void setExecution(Execution execution);

    /**
     * get the current task
     */
    public Task getTask();

    /**
     * set a current task
     */
    public void setTask(Task task);

    /**
     * set a process variable
     */
    public void setVariable(String variableName, Object value);

    /**
     * get a process variable
     */
    public Object getVariable(String variableName);

    /**
     * @return a map of process variables cached between flushes
     */
    public Map<String, Object> getCachedVariables();

}
